✨ Generate event specific reports #32
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I get an error during report generation when I run |
|
I can confirm this bug for Python 3.10. For Python 3.11 it works. Need to check. |
|
I fixed that problem, I need to instantiate a Path to be consumed by Path.open |
chrisjsewell
requested changes
Sep 1, 2023
ubmarco
changed the title
ubmarco
changed the title
chrisjsewell
approved these changes
Sep 11, 2023
danwos
approved these changes
Sep 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes it possible to aggregate the runtime of event listeners for all fired Sphinx events.
Tricky part in pyinstrument is that all event listeners appear under
EventManager.emit, so the event name is lost.The PR monkeypatches Sphinx to use a custom Event listener which injects an event specific
emitfunction, so it can be tracked in pyinstrument.The PR can be tested with
sphinx-analysis --project needs --pyinstrument --tree.A new JSON report of name
pyinstrument_sphinx_events.jsonis created.It contains all unique combinations of file path, class and function of all event listeners, so it will pick up all extensions that have listeners registered.
The dictionary
sphinx_performance/sphinx_events.py:CUSTOM_FRAMES_BY_EVENTcan be modified to add more frames of interest (unrelated to events). It is currently used to track the runtime ofsphinxcontrib-plantuml.The generated JSON file can be used for 2 purposes:
The HTML report now contains event specific function names, so event names can be searched.